<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>spi: XSpi_Config Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">spi
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('struct_x_spi___config.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">XSpi_Config Struct Reference<div class="ingroups"><a class="el" href="group__spi.html">Overview</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>This typedef contains configuration information for the device.  
 <a href="struct_x_spi___config.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a42363d8b6e4132cef06e1877c43d685b"><td class="memItemLeft" align="right" valign="top">u16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_spi___config.html#a42363d8b6e4132cef06e1877c43d685b">DeviceId</a></td></tr>
<tr class="memdesc:a42363d8b6e4132cef06e1877c43d685b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unique ID of device.  <a href="#a42363d8b6e4132cef06e1877c43d685b">More...</a><br/></td></tr>
<tr class="separator:a42363d8b6e4132cef06e1877c43d685b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a495ec19a4ab441ea59a0e220f0728dd9"><td class="memItemLeft" align="right" valign="top">UINTPTR&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_spi___config.html#a495ec19a4ab441ea59a0e220f0728dd9">BaseAddress</a></td></tr>
<tr class="memdesc:a495ec19a4ab441ea59a0e220f0728dd9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base address of the device.  <a href="#a495ec19a4ab441ea59a0e220f0728dd9">More...</a><br/></td></tr>
<tr class="separator:a495ec19a4ab441ea59a0e220f0728dd9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a192c8c69aaaf2672a35c9a228b055ffe"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_spi___config.html#a192c8c69aaaf2672a35c9a228b055ffe">HasFifos</a></td></tr>
<tr class="memdesc:a192c8c69aaaf2672a35c9a228b055ffe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Does device have FIFOs?  <a href="#a192c8c69aaaf2672a35c9a228b055ffe">More...</a><br/></td></tr>
<tr class="separator:a192c8c69aaaf2672a35c9a228b055ffe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb6d1bc96fee4723535aa51bcc0457e5"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_spi___config.html#adb6d1bc96fee4723535aa51bcc0457e5">SlaveOnly</a></td></tr>
<tr class="memdesc:adb6d1bc96fee4723535aa51bcc0457e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is the device slave only?  <a href="#adb6d1bc96fee4723535aa51bcc0457e5">More...</a><br/></td></tr>
<tr class="separator:adb6d1bc96fee4723535aa51bcc0457e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94cea54141a5f56ad620234a0583dbcd"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_spi___config.html#a94cea54141a5f56ad620234a0583dbcd">NumSlaveBits</a></td></tr>
<tr class="memdesc:a94cea54141a5f56ad620234a0583dbcd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Num of slave select bits on the device.  <a href="#a94cea54141a5f56ad620234a0583dbcd">More...</a><br/></td></tr>
<tr class="separator:a94cea54141a5f56ad620234a0583dbcd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3c3820986a993d515306dd171e299e58"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_spi___config.html#a3c3820986a993d515306dd171e299e58">DataWidth</a></td></tr>
<tr class="memdesc:a3c3820986a993d515306dd171e299e58"><td class="mdescLeft">&#160;</td><td class="mdescRight">Data transfer Width.  <a href="#a3c3820986a993d515306dd171e299e58">More...</a><br/></td></tr>
<tr class="separator:a3c3820986a993d515306dd171e299e58"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3dd5249965eb8c9957a58ed76bde2bb5"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_spi___config.html#a3dd5249965eb8c9957a58ed76bde2bb5">SpiMode</a></td></tr>
<tr class="memdesc:a3dd5249965eb8c9957a58ed76bde2bb5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Standard/Dual/Quad mode.  <a href="#a3dd5249965eb8c9957a58ed76bde2bb5">More...</a><br/></td></tr>
<tr class="separator:a3dd5249965eb8c9957a58ed76bde2bb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a06d3efabc06a2ba3cc66e7e99c0a6ee9"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_spi___config.html#a06d3efabc06a2ba3cc66e7e99c0a6ee9">AxiInterface</a></td></tr>
<tr class="memdesc:a06d3efabc06a2ba3cc66e7e99c0a6ee9"><td class="mdescLeft">&#160;</td><td class="mdescRight">AXI-Lite/AXI Full Interface.  <a href="#a06d3efabc06a2ba3cc66e7e99c0a6ee9">More...</a><br/></td></tr>
<tr class="separator:a06d3efabc06a2ba3cc66e7e99c0a6ee9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a732f0c3380dfadf62ce079b65a9be852"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_spi___config.html#a732f0c3380dfadf62ce079b65a9be852">AxiFullBaseAddress</a></td></tr>
<tr class="memdesc:a732f0c3380dfadf62ce079b65a9be852"><td class="mdescLeft">&#160;</td><td class="mdescRight">AXI Full Interface Base address of the device.  <a href="#a732f0c3380dfadf62ce079b65a9be852">More...</a><br/></td></tr>
<tr class="separator:a732f0c3380dfadf62ce079b65a9be852"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af48b4189e5dde7a7bcea3c378a6ff97b"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_spi___config.html#af48b4189e5dde7a7bcea3c378a6ff97b">XipMode</a></td></tr>
<tr class="memdesc:af48b4189e5dde7a7bcea3c378a6ff97b"><td class="mdescLeft">&#160;</td><td class="mdescRight">0 if Non-XIP, 1 if XIP Mode  <a href="#af48b4189e5dde7a7bcea3c378a6ff97b">More...</a><br/></td></tr>
<tr class="separator:af48b4189e5dde7a7bcea3c378a6ff97b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58bbefc01bd6996673fe28065a6cffec"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_spi___config.html#a58bbefc01bd6996673fe28065a6cffec">Use_Startup</a></td></tr>
<tr class="memdesc:a58bbefc01bd6996673fe28065a6cffec"><td class="mdescLeft">&#160;</td><td class="mdescRight">1 if Starup block is used in h/w  <a href="#a58bbefc01bd6996673fe28065a6cffec">More...</a><br/></td></tr>
<tr class="separator:a58bbefc01bd6996673fe28065a6cffec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc7bb33207908d8d68f0a98965ddedaa"><td class="memItemLeft" align="right" valign="top">u16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_spi___config.html#acc7bb33207908d8d68f0a98965ddedaa">FifosDepth</a></td></tr>
<tr class="memdesc:acc7bb33207908d8d68f0a98965ddedaa"><td class="mdescLeft">&#160;</td><td class="mdescRight">TX and RX FIFO Depth.  <a href="#acc7bb33207908d8d68f0a98965ddedaa">More...</a><br/></td></tr>
<tr class="separator:acc7bb33207908d8d68f0a98965ddedaa"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This typedef contains configuration information for the device. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a732f0c3380dfadf62ce079b65a9be852"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XSpi_Config::AxiFullBaseAddress</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>AXI Full Interface Base address of the device. </p>

<p>Referenced by <a class="el" href="group__spi.html#ga858155b42d5a1da8efe06c9098e40b2d">XSpi_CfgInitialize()</a>.</p>

</div>
</div>
<a class="anchor" id="a06d3efabc06a2ba3cc66e7e99c0a6ee9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XSpi_Config::AxiInterface</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>AXI-Lite/AXI Full Interface. </p>

</div>
</div>
<a class="anchor" id="a495ec19a4ab441ea59a0e220f0728dd9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">UINTPTR XSpi_Config::BaseAddress</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Base address of the device. </p>

<p>Referenced by <a class="el" href="xspi__atmel__flash__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main()</a>, <a class="el" href="xspi__intr__example_8c.html#abd314964daed3d1fb324ef61ed37f276">SpiIntrExample()</a>, <a class="el" href="xspi__polled__example_8c.html#a0dd02b93ca6a7d528f41113065a1e3cb">SpiPolledExample()</a>, <a class="el" href="xspi__selftest__example_8c.html#aa80f2f9d52f6c35db2d43a56802a81c8">SpiSelfTestExample()</a>, <a class="el" href="xspi__winbond__flash__xip__example_8c.html#af3fb7f2668aa93bc45fb9ca9c252f219">SpiXipExample()</a>, and <a class="el" href="group__spi.html#gaa1fb3e31ba804cc87dc309847fb02471">XSpi_Initialize()</a>.</p>

</div>
</div>
<a class="anchor" id="a3c3820986a993d515306dd171e299e58"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XSpi_Config::DataWidth</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Data transfer Width. </p>

<p>Referenced by <a class="el" href="group__spi.html#ga858155b42d5a1da8efe06c9098e40b2d">XSpi_CfgInitialize()</a>.</p>

</div>
</div>
<a class="anchor" id="a42363d8b6e4132cef06e1877c43d685b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u16 XSpi_Config::DeviceId</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Unique ID of device. </p>

</div>
</div>
<a class="anchor" id="acc7bb33207908d8d68f0a98965ddedaa"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u16 XSpi_Config::FifosDepth</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>TX and RX FIFO Depth. </p>

<p>Referenced by <a class="el" href="group__spi.html#ga858155b42d5a1da8efe06c9098e40b2d">XSpi_CfgInitialize()</a>.</p>

</div>
</div>
<a class="anchor" id="a192c8c69aaaf2672a35c9a228b055ffe"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XSpi_Config::HasFifos</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Does device have FIFOs? </p>

<p>Referenced by <a class="el" href="group__spi.html#ga858155b42d5a1da8efe06c9098e40b2d">XSpi_CfgInitialize()</a>.</p>

</div>
</div>
<a class="anchor" id="a94cea54141a5f56ad620234a0583dbcd"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XSpi_Config::NumSlaveBits</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Num of slave select bits on the device. </p>

<p>Referenced by <a class="el" href="group__spi.html#ga858155b42d5a1da8efe06c9098e40b2d">XSpi_CfgInitialize()</a>.</p>

</div>
</div>
<a class="anchor" id="adb6d1bc96fee4723535aa51bcc0457e5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XSpi_Config::SlaveOnly</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Is the device slave only? </p>

<p>Referenced by <a class="el" href="group__spi.html#ga858155b42d5a1da8efe06c9098e40b2d">XSpi_CfgInitialize()</a>.</p>

</div>
</div>
<a class="anchor" id="a3dd5249965eb8c9957a58ed76bde2bb5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XSpi_Config::SpiMode</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Standard/Dual/Quad mode. </p>

<p>Referenced by <a class="el" href="group__spi.html#ga858155b42d5a1da8efe06c9098e40b2d">XSpi_CfgInitialize()</a>.</p>

</div>
</div>
<a class="anchor" id="a58bbefc01bd6996673fe28065a6cffec"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XSpi_Config::Use_Startup</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>1 if Starup block is used in h/w </p>

<p>Referenced by <a class="el" href="group__spi.html#ga858155b42d5a1da8efe06c9098e40b2d">XSpi_CfgInitialize()</a>.</p>

</div>
</div>
<a class="anchor" id="af48b4189e5dde7a7bcea3c378a6ff97b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XSpi_Config::XipMode</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>0 if Non-XIP, 1 if XIP Mode </p>

<p>Referenced by <a class="el" href="group__spi.html#ga858155b42d5a1da8efe06c9098e40b2d">XSpi_CfgInitialize()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
